Request response definitions and other clarifications in chapter 5 of API Design Guide#450
Conversation
ediorial format section 5.7.6
editorial format section 5.8.5 Headers, x-correlator
PedroDiez
left a comment
There was a problem hiding this comment.
Have made some editorial format updates in Commits:
editorial format section 5.7.6
editorial format section 5.8.5 Headers, x-correlator
Fine with the updates, LGTM in advance
clarificagtion on images location Co-authored-by: tlohmar <Thorsten.Lohmar@ericsson.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
|
@tlohmar
Since the releases are generated from the |
| `description`field: There are no special restrictions specified in CAMARA for the documentation explaining API. | ||
| [CommonMark syntax](https://spec.commonmark.org/) may be used for rich text representation. | ||
| Images hosted in Github API repository can be embedded in the description, for example: | ||
| It is not recommended to link images outsite of the Github API repository, since changes to these images may be outside of control of repository maintainers. Images should be preferably hosted within the API repository within the `documentation/API_documentation/resources` folder. Images should be included in the release branch. This ensures, that images can be updated with API releases. |
There was a problem hiding this comment.
| It is not recommended to link images outsite of the Github API repository, since changes to these images may be outside of control of repository maintainers. Images should be preferably hosted within the API repository within the `documentation/API_documentation/resources` folder. Images should be included in the release branch. This ensures, that images can be updated with API releases. | |
| It is not recommended to link images outside of the Github API repository, since changes to these images may be outside of the control of repository maintainers. Images should preferably be hosted within the API repository within the `documentation/API_documentation/resources` folder. Images should be included in the release branch. This ensures that images can be updated with API releases. | |
ok, fine when redundant. The important thing is, that people find and follow these instructions. |
Typos indicated by @Kevsy
What type of PR is this?
What this PR does / why we need it:
Request response definitions and other clarifications in chapter 5 of API Design Guide based on previous review comments
Which issue(s) this PR fixes:
Fixes #445
Does this PR introduce a breaking change?
Special notes for reviewers:
Changelog input