Talk:OpenAPI Specification: Difference between revisions

Content deleted Content added
Sample code: new section
Sample code: Thanks for the examples link. I see that they can express the API as at least JSON and YAML. That should be in the article. Perhaps a JSON version compacted to not put lines with only one bracket or the YAML version could fit in the article. The [https://learn.openapis.org/examples/v3.1/non-oauth-scopes.html non-oauth-scopes] example is small enough, but not very clear, I think.
 
(One intermediate revision by one other user not shown)
Line 46:
Can we have some sample code such as a [[Hello World]]?
-- [[User:Error|Error]] ([[User talk:Error|talk]]) 20:40, 20 January 2025 (UTC)
 
:@[[User:Error|Error]]the OpenAPI Specification is a specification not a programming language or any one tool (there are many tools that use the specification for a variety of purposes). The OAS is not a very concise format, so embedding an example API description (similar to those on OpenAPI's [https://learn.openapis.org/examples/ learn site]) would take up a lot of space and require a more in-depth article to explain what the example means. It's not clear to me if it makes sense to go into that much detail on a wikipedia article. (Although if someone sees a good way to add an example here, please do not let my comment stop you!)
:[[User:Ixat totep|Ixat totep]] ([[User talk:Ixat totep|talk]]) 16:35, 21 January 2025 (UTC)
::Thanks for the examples link. I see that they can express the API as at least JSON and YAML. That should be in the article.
::Perhaps a JSON version compacted to not put lines with only one bracket or the YAML version could fit in the article.
::The [https://learn.openapis.org/examples/v3.1/non-oauth-scopes.html non-oauth-scopes] example is small enough, but not very clear, I think.
::-- [[User:Error|Error]] ([[User talk:Error|talk]]) 02:21, 23 January 2025 (UTC)