Clarification on api-name, filenames and servers object #333
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Update API-design-guidelines.md * Update API-design-guidelines.md * Clarifications on api-name, filenames and servers object * Revert "Update API-design-guidelines.md" This reverts commit 1353c82. --------- Co-authored-by: rartych <[email protected]>
rartych
requested review from
shilpa-padgaonkar,
patrice-conil,
RubenBG7 and
PedroDiez
as code owners
This was referenced Nov 6, 2024
gmuratk
reviewed
Nov 8, 2024
| @@ -1298,6 +1299,7 @@ servers: | |||
| default: http://localhost:9091 | |||
| description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath` | |||
| ``` | |||
| If more than one server object instances are listed, each `servers[*].url` property must have the same string for the `api-name` and `api-version` in respective instance. | |||
There was a problem hiding this comment.
@rartych, I don't think I had this sentence formulated correctly in my original suggestion. I suggest the following as the final string:
If more than one server object instances is listed, the servers[*].url property of each instance must have the same values for the api-name and api-version.
There was a problem hiding this comment.
Corrected in a59b7aa
gmuratk
approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Missing guideline for file names of API definition files, indirect definition of
api-namevariable.This PR adds the definition of api-name to Common Vocabulary and Acronyms and clarifies the name of API definition files and servers object content
Which issue(s) this PR fixes:
Fixes #298 #284
Does this PR introduce a breaking change?
Special notes for reviewers:
Do we need similar definition of 'api-version'?
JSON format is not currently used in any subproject, should the file extension .json be removed?
Changelog input
Additional documentation