Fixes to documentation

[estevegf]

Hi,

After reading the docs I've found some issues (please do apologize me if any of them is a misunderstanding):

• "RAML does not define validation when a header declaration specifies any of the following types for the value of the header: an object type, a union of non-scalar types, or an array type if the underlying type of the array is an object type, array type, or a union of non-scalar types."

  • a union of non-scalar types is repeated
  • an array type if the underlying type of the array is an object type seems to be mutually exclusive to array type assertion

• types:

  Email:
  type: string
  minLength: 2
  maxLength: 6
  pattern: **^note\d+$**

  probably you're pasting the pattern from an example in another section above in the docs.

• "sets the value of resourcePathName and resourcePath parameters to "/bom/{itemId}" and "bom", respectively." I guess this statement should be reversed.

I wait for your news.

Thanks

[jstoiko]

Thanks for this @estevegf. Added some your points to be released as part of the v1.0.1 patch.

Regarding:

• your 1st point: I do not see any issue with that sentence. It should be read as follows:

  
  RAML does not define validation when a header declaration specifies any of the following types for the value of the header: 

• an object type,
• a union of non-scalar types, or
• an array type if the underlying type of the array is
  • an object type,
  • array type, or
  • a union of non-scalar types.

• your 2nd point: good catch. See b76d1d0.
• your 3rd point: good catch. See 8a45c85.

[estevegf]

Good Work!

Keep working 💪

El lun., 21 sept. 2020 21:18, Jonathan Stoikovitch notifications@github.com escribió:

Thanks for this @estevegf https://github.com/estevegf. Added some your points to be released as part of the v1.0.1 patch.

Regarding:

• your 1st point: I do not see any issue with that sentence. It should be read as follows:

RAML does not define validation when a header declaration specifies any of the following types for the value of the header:

• an object type,
• a union of non-scalar types, or

• an array type if the underlying type of the array is

  • an object type,

  • array type, or

  • a union of non-scalar types.

  • your 2nd point: good catch. See b76d1d0 https://github.com/raml-org/raml-spec/commit/b76d1d04bcab77c86e0a8d18ff40ea7c9eb6373d .

  • your 3rd point: good catch. See 8a45c85 https://github.com/raml-org/raml-spec/commit/8a45c85df46e931b07476490888a9e650688d64c .

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/raml-org/raml-spec/issues/729#issuecomment-696317891, or unsubscribe https://github.com/notifications/unsubscribe-auth/AELWWPLFLNMZYIKC2XDLNOLSG6RG7ANCNFSM4KWF5S4A .