Skip to content

Commit

Permalink
Merge pull request #289 from chris-little/master
Browse files Browse the repository at this point in the history
Minor grammar and typo improvements
  • Loading branch information
cmheazel authored Sep 3, 2021
2 parents 3cad90d + 82ca68e commit f9f0923
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 7 deletions.
1 change: 0 additions & 1 deletion core/annex_bibliography.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
* [[fielding2000]] Fielding, Roy Thomas: *Architectural Styles and the Design of Network-based Software Architectures*. Doctoral dissertation, University of California, Irvine, 2000, https://www.ics.uci.edu/~fielding/pubs/dissertation/fielding_dissertation.pdf[https://www.ics.uci.edu/fielding/pubs/dissertation/fielding_dissertation.pdf]
* [[k-and-r-1978]] Kernighan, B., Richie, D.: *The C Programming Language*, Bell Laboratories, 1978
* [[link-relations]] IANA: **Link Relation Types**, https://www.iana.org/assignments/link-relations/link-relations.xml
* [[rfc6570]] Greforio, J., Fielding, R., Hadley, M., Nottingham, M., Orchard, D.: *IETF RFC 6570, URI Template*, https://tools.ietf.org/html/rfc6570[https://tools.ietf.org/html/rfc6570]
* [[rfc7230]] Fielding, R., Reschke, J.: **IETF RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing**, https://tools.ietf.org/rfc/rfc7230.txt[https://tools.ietf.org/rfc/rfc7230.txt]
* [[rfc7235]] Fielding, R., Reschke, J.: **IETF RFC 7235, Hypertext Transfer Protocol (HTTP/1.1): Authentication**, https://tools.ietf.org/rfc/rfc7235.txt[https://tools.ietf.org/rfc/rfc7235.txt]
* [[rfc7538]] Reschke, J.: **IETF RFC 7538, The Hypertext Transfer Protocol Status Code 308 (Permanent Redirect)**, https://tools.ietf.org/rfc/rfc7538.txt[https://tools.ietf.org/rfc/rfc7538.txt]
Expand Down
2 changes: 1 addition & 1 deletion core/clause_3_conformance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The OGC API - Common Standard does not mandate a specific encoding or format for
* <<rc_html-section,HTML>>
* <<rc_json-section,JSON>>

Neither of these encodings is mandatory. An implementer of the _API-Common_ standard may decide to implement another encodings instead of, or in addition to, these two.
Neither of these encodings is mandatory. An implementer of the _API-Common_ standard may decide to implement other encodings instead of, or in addition to, these two.

The Encoding Requirements Classes are specified in <<rc_encoding-section,(Chapter 10)>> *Encoding Requirements Classes*.

Expand Down
1 change: 1 addition & 0 deletions core/clause_4_references.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ The following normative documents contain provisions that, through reference in

* [[rfc2818]] Rescorla, E.: **IETF RFC 2818, HTTP Over TLS**, http://tools.ietf.org/rfc/rfc2818.txt[http://tools.ietf.org/rfc/rfc2818.txt]
* [[rfc3986]] Berners-Lee, T., Fielding, R., Masinter, L: **IETF RFC 3986, Uniform Resource Identifier (URI): Generic Syntax**, http://tools.ietf.org/rfc/rfc3986.txt[http://tools.ietf.org/rfc/rfc3986.txt]
* [[rfc6570]] Gregorio, J., Fielding, R., Hadley, M., Nottingham, M., Orchard, D: **IETF RFC 6570, URI Template**, https://www.rfc-editor.org/rfc/rfc6570.txt[https://www.rfc-editor.org/rfc/rfc6570.txt]
* [[rfc7231]] Fielding, R., Reschke, J.: **IETF RFC 7231, Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content**, https://tools.ietf.org/rfc/rfc7231.txt[https://tools.ietf.org/rfc/rfc7231.txt]
* [[rfc7232]] Fielding, R., Reschke, J.: **IETF RFC 7232, Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests**, https://tools.ietf.org/rfc/rfc7232.txt[https://tools.ietf.org/rfc/rfc7232.txt]
* [[rfc7807]] Nottingham, M., Wilde, E.: **IETF RFC 7807, Problem Details for HTTP APIs**, https://tools.ietf.org/rfc/rfc7807.txt[https://tools.ietf.org/rfc/rfc7807.txt]
Expand Down
4 changes: 3 additions & 1 deletion core/clause_5_terms_and_definitions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For the purposes of this document, the following additional terms and definition

[[kebab-case-definition]]
* *Kebab case* +
A case style where punctuation is removed and spaces are replaced by single hyphens. All letters are in lower case when used in OGC documentation. (https://en.wikipedia.org/wiki/Letter_case[Wikipedia])
A case style where punctuation is removed and spaces are replaced by single hyphens. All letters are in lower case when used in OGC documentation. (https://en.wikipedia.org/wiki/Letter_case[Wikipedia]) Example: `kebab-case-style`

[[landing-page-definition]]
* *Landing Page* +
Expand Down Expand Up @@ -80,6 +80,8 @@ OGC::
Open Geospatial Consortium
URI::
Uniform Resource Identifier
URL::
Uniform Resource Locator
YAML::
YAML Ain’t Markup Language

4 changes: 2 additions & 2 deletions core/clause_6_conventions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,14 @@ OGC {root} path parameters

This document does not restrict the lexical space of URIs used in the API beyond the requirements of the <<rfc7231,HTTP>> and <<rfc3986,URI Syntax>> IETF RFCs. If URIs include reserved characters that are delimiters in the URI subcomponent, these have to be percent-encoded. See Clause 2 of <<rfc3986,RFC 3986>> for details.

NOTE: OGC Web API standards may include a community-defined identifier as part of a URI (ex. image id or feature id). Definition of the format of those identifiers is out of scope for these standards. Implementers should take care that these identifiers are properly encoded (see <<rfc3986,RFC 3986>>) in the URIs for all hosted resources.
NOTE: OGC Web API standards may include a community-defined identifier as part of a URI (for example: image id or feature id). Definition of the format of those identifiers is out of scope for these standards. Implementers should take care that these identifiers are properly encoded (see <<rfc3986,RFC 3986>>) in the URIs for all hosted resources.

Additional information on this topic is provided in the link:http://docs.opengeospatial.org/DRAFTS/20-071.html#identifiers-section[OGC API - Common Users Guide].

[[link-conventions]]
=== Links

OGC Web API Standards use <<rfc8288,RFC 8288 (Web Linking)>> to express relationships between resources. Resource representations defined in these standards commonly include an "links" element. A "links" element is an array of individual hyperlink elements. These "links" elements provide a convention for associating related resources.
OGC Web API Standards use <<rfc8288,RFC 8288 (Web Linking)>> to express relationships between resources. Resource representations defined in these standards commonly include a "links" element. A "links" element is an array of individual hyperlink elements. These "links" elements provide a convention for associating related resources.

The individual hyperlink elements that make up a "links" element are defined using the following link:http://beta.schemas.opengis.net/ogcapi/common/part1/0.1/core/openapi/schemas/link.yaml[Hyperlink Schema].

Expand Down
2 changes: 1 addition & 1 deletion core/clause_8_landing-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The purpose of the landing page is to provide clients with a starting point for

The landing page includes three metadata elements: title, description, and attribution. These three elements describe the API as a whole. Clients can expect to encounter metadata that is more resource-specific as they follow links and paths from the landing page.

While the three metadata elements are defined as text strings, the attribution element is special. Specifically, The attribution element can contain markup text. Markup allows a text string to import images and format text. The capabilities are only limited by the markup language used. See the example <<json-landing-page,landing page>> for an example of the use of markup in the attribution element.
While the three metadata elements are defined as text strings, the attribution element is special. Specifically, the attribution element can contain markup text. Markup allows a text string to import images and format text. The capabilities are only limited by the markup language used. See the example <<json-landing-page,landing page>> for an example of the use of markup in the attribution element.

==== Operation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
[width="90%",cols="2,6a"]
|===
^|*Recommendation {counter:rec-id}* |*/rec/core/query-param-capitalization*
^|A |Query parameter names SHOULD be in <<kebab-case-definition,Kebab case>>.
^|A |Query parameter names SHOULD be in <<kebab-case-definition,kebab case>>.
^|B |Query parameter values are usually reflective of the internal structure of the target resource. Unless otherwise specified, these values SHOULD be in <<kebab-case-definition,kebab case>>.
|===

0 comments on commit f9f0923

Please sign in to comment.