クラス PayloadDocumentation

メソッドの詳細

• fieldWithPath

  public static FieldDescriptor fieldWithPath(StringSE path)

  指定された path でフィールドを記述する FieldDescriptor を作成します。

  XML ペイロードをドキュメント化するとき、path は XPath を使用します。つまり、"/" は子ノードに下降するために使用されます。

  JSON ペイロードをドキュメント化する場合、path は "." を使用します。' []' は子オブジェクトに降下し、' []' は配列に降下します。例: この JSON ペイロードの場合:

  {
     "a":{
         "b":[
             {
                 "c":"one"
             },
             {
                 "c":"two"
             },
             {
                 "d":"three"
             }
         ]
     }
  }
  

  次のパスはすべて存在します。

  存在するパスとその値

  パス	値
  a	"b" を含むオブジェクト
  a.b	3 つのオブジェクトを含む配列
  a.b[]	3 つのオブジェクトを含む配列
  a.b[].c	文字列 "one" と "two" を含む配列
  a.b[].d	文字列 "3"

  パラメーター:

  path - フィールドのパス

  戻り値:

  さらに構成する準備ができている FieldDescriptor 

• subsectionWithPath

  public static SubsectionDescriptor subsectionWithPath(StringSE path)

  指定された path を使用して、サブセクション、つまりフィールドとそのすべての子孫を記述する FieldDescriptor を作成します。

  XML ペイロードをドキュメント化するとき、path は XPath を使用します。つまり、"/" は子ノードに下降するために使用されます。

  JSON ペイロードをドキュメント化する場合、path は "." を使用します。' []' は子オブジェクトに降下し、' []' は配列に降下します。例: この JSON ペイロードの場合:

  {
     "a":{
         "b":[
             {
                 "c":"one"
             },
             {
                 "c":"two"
             },
             {
                 "d":"three"
             }
         ]
     }
  }
  

  次のパスはすべて存在します。

  存在するパスとその値

  パス	値
  a	"b" を含むオブジェクト
  a.b	3 つのオブジェクトを含む配列
  a.b[]	3 つのオブジェクトを含む配列
  a.b[].c	文字列 "one" と "two" を含む配列
  a.b[].d	文字列 "3"

  パス a.b[] を持つ配列のサブセクション記述子は、その子孫 a.b[].c および a.b[].d も記述します。

  パラメーター:

  path - サブセクションのパス

  戻り値:

  さらに構成する準備ができている SubsectionDescriptor 

• requestFields

  public static RequestFieldsSnippet requestFields(FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエストペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • AbstractDescriptor.description(Object)

• requestFields

  public static RequestFieldsSnippet requestFields(ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエストペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエストペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエストペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエストペイロードのサブセクションに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクション内のフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエストペイロードのサブセクションに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエストペイロードのサブセクションに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestFields

  public static RequestFieldsSnippet requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエストペイロードのサブセクションに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestFields

  public static RequestFieldsSnippet relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  指定された subsectionExtractor によって抽出された API オペレーションのリクエストペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエストペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエスト部分のペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエスト部分のペイロードに存在しない場合も、エラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがリクエスト部分のペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエスト部分のペイロードに存在しない場合も、エラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエスト部分のペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエスト部分のペイロードに存在しない場合も、エラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがリクエスト部分のペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエスト部分のペイロードに存在しない場合も、エラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  リクエスト部分のペイロードのサブセクションにフィールドが存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  descriptors - サブセクションのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  リクエスト部分のペイロードのサブセクションにフィールドが存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  descriptors - サブセクションのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、与えられた subsectionExtractor によって抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  リクエスト部分のペイロードのサブセクションにフィールドが存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestPartFields

  public static RequestPartFieldsSnippet requestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  リクエスト部分のペイロードのサブセクションにフィールドが存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、サブセクションに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedRequestPartFields

  public static RequestPartFieldsSnippet relaxedRequestPartFields(StringSE part, PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのリクエストペイロードの指定された part のサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor によって抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  part - パーツ名

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - リクエスト部分のフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのフィールドをドキュメント化する Snippet を返します。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスペイロードに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスペイロードに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは、指定された descriptors を使用してドキュメント化されます。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスペイロードに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• responseFields

  public static ResponseFieldsSnippet responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがレスポンスペイロードに存在するが、いずれかの記述子によってドキュメント化されていない場合、スニペットの呼び出し時にエラーが発生します。同様に、フィールドがドキュメント化されており、オプションとしてマークされておらず、レスポンスペイロードに存在しない場合もエラーが発生します。階層構造を持つペイロードの場合、フィールドを subsection descriptor でドキュメント化すると、その子孫もすべてドキュメント化されたものとして扱われることになります。

  フィールドまたはサブセクションをドキュメント化したくない場合は、記述子を configured to ignore it にすることができます。無視されたフィールドまたはサブセクションは生成されたスニペットには表示されず、上記のエラーは発生しません。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, FieldDescriptor... descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• relaxedResponseFields

  public static ResponseFieldsSnippet relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes, ListSE<FieldDescriptor> descriptors)

  API オペレーションのレスポンスペイロードのサブセクションのフィールドをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。フィールドは指定された descriptors を使用してドキュメント化され、指定された attributes はスニペットの生成中に使用可能になります。

  フィールドがドキュメント化されており、オプションとしてマークされておらず、リクエストに存在しない場合、エラーが発生します。ドキュメント化されていないフィールドは無視されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  descriptors - レスポンスペイロードのフィールドの説明

  戻り値:

  フィールドをドキュメント化するスニペット

  導入:

  1.2.0

  関連事項:

  • fieldWithPath(String)
  • subsectionWithPath(String)
  • beneathPath(String)

• requestBody

  public static RequestBodySnippet requestBody()

  API 操作のリクエストペイロードの本文をドキュメント化する Snippet を返します。

  戻り値:

  リクエスト本文をドキュメント化するスニペット

• requestBody

  public static RequestBodySnippet requestBody(MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのリクエストペイロードの本文をドキュメント化する Snippet を返します。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  attributes - 属性

  戻り値:

  リクエスト本文をドキュメント化するスニペット

• requestBody

  public static RequestBodySnippet requestBody(PayloadSubsectionExtractor<?> subsectionExtractor)

  API オペレーションのリクエストペイロードの本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  戻り値:

  リクエスト本文のサブセクションをドキュメント化するスニペット

• requestBody

  public static RequestBodySnippet requestBody(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのリクエストペイロードの本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  戻り値:

  リクエスト本文のサブセクションをドキュメント化するスニペット

• responseBody

  public static ResponseBodySnippet responseBody()

  API 操作のレスポンスペイロードの本文をドキュメント化する Snippet を返します。

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• responseBody

  public static ResponseBodySnippet responseBody(MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのレスポンスペイロードの本文をドキュメント化する Snippet を返します。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  attributes - 属性

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• responseBody

  public static ResponseBodySnippet responseBody(PayloadSubsectionExtractor<?> subsectionExtractor)

  API オペレーションのレスポンスペイロードの本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  戻り値:

  レスポンス本文のサブセクションをドキュメント化するスニペット

• responseBody

  public static ResponseBodySnippet responseBody(PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのレスポンスペイロードの本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  戻り値:

  レスポンス本文のサブセクションをドキュメント化するスニペット

• requestPartBody

  public static RequestPartBodySnippet requestPartBody(StringSE partName)

  API 操作のリクエストペイロードの指定された部分の本文をドキュメント化する Snippet を返します。

  パラメーター:

  partName - リクエスト部分の名前

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• requestPartBody

  public static RequestPartBodySnippet requestPartBody(StringSE partName, MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのリクエストペイロードの指定された部分の本文をドキュメント化する Snippet を返します。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  partName - リクエスト部分の名前

  attributes - 属性

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• requestPartBody

  public static RequestPartBodySnippet requestPartBody(StringSE partName, PayloadSubsectionExtractor<?> subsectionExtractor)

  API オペレーションのリクエストペイロードの指定された部分の本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。

  パラメーター:

  partName - リクエスト部分の名前

  subsectionExtractor - サブセクションエクストラクター

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• requestPartBody

  public static RequestPartBodySnippet requestPartBody(StringSE partName, PayloadSubsectionExtractor<?> subsectionExtractor, MapSE<StringSE,ObjectSE> attributes)

  API オペレーションのリクエストペイロードの指定された部分の本文のサブセクションをドキュメント化する Snippet を返します。サブセクションは、指定された subsectionExtractor を使用して抽出されます。指定された属性は、スニペットの生成中に使用できるようになります。

  パラメーター:

  partName - リクエスト部分の名前

  subsectionExtractor - サブセクションエクストラクター

  attributes - 属性

  戻り値:

  レスポンス本文をドキュメント化するスニペット

• applyPathPrefix

  public static ListSE<FieldDescriptor> applyPathPrefix(StringSE pathPrefix, ListSE<FieldDescriptor> descriptors)

  指定された pathPrefix がパスに適用された、指定された descriptors のコピーを作成します。

  パラメーター:

  pathPrefix - パスプレフィックス

  descriptors - コピーする記述子

  戻り値:

  プレフィックスが適用されたコピーされた記述子

• beneathPath

  public static PayloadSubsectionExtractor<?> beneathPath(StringSE path)

  指定された path にある JSON ペイロードのサブセクションを抽出する PayloadSubsectionExtractor を返します。

  パラメーター:

  path - パス

  戻り値:

  サブセクションエクストラクター

  導入:

  1.2.0