Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API title to landing page #227

Closed
cportele opened this issue Jun 6, 2019 · 3 comments · Fixed by #229
Closed

Add API title to landing page #227

cportele opened this issue Jun 6, 2019 · 3 comments · Fixed by #229
Assignees
Labels
OGC API: Common Issue related to general resources or requirements (see #190) Part 1: Core Issue related to Part 1 - Core progress: resolution agreed

Comments

@cportele
Copy link
Member

cportele commented Jun 6, 2019

From gitter discussion:

@bradh: If I want the title for the service (i.e. above collection level), I have to get it from the openapi description? That'd be a handy thing to provide in the main / level doc.

@cportele cportele added Part 1: Core Issue related to Part 1 - Core OGC API: Common Issue related to general resources or requirements (see #190) labels Jun 6, 2019
@cportele cportele added this to the Part 1, Second Draft Release milestone Jun 6, 2019
@cportele
Copy link
Member Author

cportele commented Jun 6, 2019

Yes, that would support the use of the API by a client that knows the standard and follows a more hypermedia-driven approach (and which does not analyse the API definition). It introduces some redundancy with the API definition, but if we limit it to the title (and maybe the description) that would be ok with me.

@bradh
Copy link
Contributor

bradh commented Jun 6, 2019

The specific case: client code wants to have a user-friendly display name to go with the URL:

image

If I could avoid parsing the openapi (rel='service'), that would have me a server round trip just to get a reasonable display name.

@cportele
Copy link
Member Author

cportele commented Jun 10, 2019

Conference call 10 June 2019: Agreement to include the title and description in the landing page. The values should be consistent with the API definition. We do not want to go beyond title/description otherwise consistency will become more difficult. @cportele to implement this directly so that we have a clean version before the hackathon. The change is not considered controversial. @pvretano will update the XML, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OGC API: Common Issue related to general resources or requirements (see #190) Part 1: Core Issue related to Part 1 - Core progress: resolution agreed
Projects
Development

Successfully merging a pull request may close this issue.

2 participants